home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / doorware / blueq170.zip / BLUEQWK.DOC < prev    next >
Text File  |  1996-10-25  |  22KB  |  487 lines

  1.  
  2.           BlueQWK v1.70 - BLUEQ170.ZIP - 25-October-1996
  3.           Copyright (C) 1992-96 Simple Solutions Software,
  4.           All Rights Reserved.
  5.  
  6.           Residence:   Geoffrey Sy
  7.                        14 Blevins Place 1322
  8.                        Toronto ON  M5A 3M5
  9.                        Canada
  10.  
  11.           FidoNet:     1:250/814
  12.  
  13.           InterNet:    ae873@torfree.net
  14.                        sy@to.org
  15.  
  16.           Support BBS: CAP/CANADA (416) 287-0935 v.Everything
  17.                                   (416) 287-0234 v.Everything
  18.                          Conference: CL_SimpleSoln #4
  19.  
  20.           Latest versions of most QWK utilities, including BlueQWK, can
  21.           be found on The Lunatic Fringe BBS 214-235-5288 (1:124/2113).
  22.  
  23.           FTP: ftp.coast.net /SimTel/msdos/offline on the internet for
  24.           the latest version of your favourite offline mail utilities.
  25.  
  26.           ═════════════════════════════════════════════════════════════
  27.           BlueQWK converts  BlueWave mail packets  to a format readable
  28.           by QWK mail readers.  It is designed to interface seamlessly
  29.           with most DOS-based QWK off-line mail readers.
  30.  
  31.           INSTALLATION for 1stReader (as well as other OLMRs):
  32.  
  33.               1.  Copy BLUEQWK.EXE into your 1stReader directory.  If
  34.                   using 1stReader v1.10, unZIP 1ST11.RDR into your
  35.                   1stReader directory.  If using 1stReader v2.0 unZIP
  36.                   1ST20.RDR into your 1stReader directory.
  37.  
  38.           OPERATION:
  39.  
  40.               1.  This version of BlueQWK needs more memory than older
  41.                   versions, so you might need to enable 1stReader's
  42.                   SuperShell to free up some memory before executing
  43.                   BlueQWK.
  44.  
  45.               2.  When you start 1stReader, append the switch /QWK:* to
  46.                   the 1stReader command line.  This switch can also go
  47.                   into your SWITCHES.1ST file.
  48.  
  49.           BlueQWK automatically copies BlueWave *.INF files into same
  50.           directory as itself.  This allows for conversion of replies
  51.           without the need for a BlueWave packet to be present.
  52.  
  53.           The reply packet for uploading to the BlueWave door still
  54.           have the .REP extension.  1st Reader doesn't have any hooks
  55.           to take care of this.  The 1st Reader /REP: NEW switch won't
  56.           work in this case unless you want all your reply packets to
  57.           have the .NEW extension.  This isn't a problem because the
  58.           replies packet is automatically renamed to <BBS_ID>.NEW when
  59.           the Bluewave door received it.
  60.  
  61.           There is an internal hook that 1stReader provide for BW-QWK
  62.           conversion.  It does not work when writing replies without
  63.           the presence of a mail packet.  This hook causes DOS to issue
  64.           'Bad command or file name' when reading Bluewave packets.  If
  65.           this DOS error annoys you, download DLXTEXT.EXE or QMTEXT.EXE
  66.           from Sparky to edit your 1STTEXT file.  Place the word REM in
  67.           front of records #297, 298, and 299 in 1STTEXT to fix this.
  68.  
  69.           ═════════════════════════════════════════════════════════════
  70.           INSTALLATION for other readers:
  71.  
  72.               1.  Put BLUEQWK.EXE into your reader directory or
  73.                   anywhere on your DOS PATH.
  74.  
  75.               2.  Replace the compression/decompression utilities with
  76.                   batch files.  Then do some simple batch programming.
  77.  
  78.                   Included in this package are several files with the
  79.                   .RDR extension.  These are .ZIP files containing
  80.                   sample .CFG and .BAT files for use with other mail
  81.                   readers.  They also contain configuration files for
  82.                   the mail reader, so becareful not to overwrite your
  83.                   mail reader's configuration files.  These files are:
  84.  
  85.                   DLX12.RDR - For use with Sparkware's Deluxe² v1.2x
  86.                               and probably older versions as well.
  87.                   OLX22.RDR - For use with OLX v2.2.  Will probably
  88.                               work with SLMR and earlier OLX versions
  89.                   OLX30.RDR - For use with OLX v3.1.52.  May work with
  90.                               prior release of OLX v3.xx
  91.                   SR140.RDR - For use with Speed Read v1.40.  May work
  92.                               with earlier and later versions.
  93.                   RM130.RDR - For use with RoboMail v1.30.  May work
  94.                               with earlier and later versions.
  95.  
  96.                   Unzip the appropriate .RDR into the same directory as
  97.                   BLUEQWK.EXE.  Then configure your reader to call the
  98.                   appropriate PACKER/UNPACKER .BATch file. Please refer
  99.                   to the README.TXT file inside the .RDR files for more
  100.                   information.
  101.  
  102.               3.  You may need to change the extension of the BW mail
  103.                   packets to *.QWK inorder for your mail reader to find
  104.                   the mail packets.
  105.  
  106.               If the above steps don't work for your OLMR, these
  107.               information may help:
  108.  
  109.                   The basic command line to run BlueQWK follows:
  110.  
  111.                   BLUEQWK BBS_ID conversion_method
  112.  
  113.                   - BBS_ID can be anything that contains the name of
  114.                     the QWK/REP packet.  This may include the mail
  115.                     packet name as passed by your mail reader to the
  116.                     compression/decompression utilities.  If the BBS_ID
  117.                     is not known, use an asterisk '*' to let BlueQWK
  118.                     find/guess the BBS_ID.
  119.  
  120.                   - conversion_method has 3 options:
  121.  
  122.                    1. BW-QWK converts BlueWave mail packet to QWK for
  123.                       reading with your QWK reader.
  124.                    2. BW-REP converts BlueWave replies to .REP for
  125.                       re-editing them with your QWK reader.
  126.                    3. REP-BW converts .REP to BlueWave for uploading
  127.                       to the BlueWave door
  128.  
  129.                   The BLUEQWK.CFG needs the following info:
  130.  
  131.                     Line 1: Directory of QWK work directory.  This is
  132.                             where your mail reader decompress the mail
  133.                             packet to. Most readers will change to this
  134.                             directory before opening the mail packet,
  135.                             so a ".\" (without the quotes) will work in
  136.                             most cases.
  137.  
  138.                     Line 2: Directory of REP work directory.  This is
  139.                             where BlueQWK expects to find the reply
  140.                             file created by your mail reader.  BlueQWK
  141.                             uses this directory to store the converted
  142.                             Bluewave replies.  Most readers don't use a
  143.                             separate directory for this purpose.  In
  144.                             such case, create a work directory and copy
  145.                             the reply file into it.  Please refer to
  146.                             OLX22.RDR for the solution to this problem.
  147.  
  148.                     Line 3: Optional switches for BlueQWK.  Currently
  149.                             these switches are supported:
  150.  
  151.                             /Quiet
  152.                                Tells BlueQWK not to list the header of
  153.                                messages it processed.
  154.  
  155.                             /NoNDX
  156.                                Tells BlueQWK not to create the QWK
  157.                                index (*.NDX) files.
  158.  
  159.                             /1stBM
  160.                                 Fix a problem with 1stReader v2's "new"
  161.                                 book-mark scheme.  If BlueQWK finds
  162.                                 BOOKMARK.DAT in the QWK work directory,
  163.                                 it will not attempt to convert the BW
  164.                                 mail packet.  This new book-mark scheme
  165.                                 is unquestionably the worst function
  166.                                 found in 1stReader.
  167.  
  168.                             /NoERR
  169.                                 Suppress error messages such as "No
  170.                                 Replies found" or "No BW mail packet
  171.                                 found".
  172.  
  173.                             /AreaNum
  174.                                 Use BBS area numbers instead of creating
  175.                                 sequential ones.  Make sure the BBS does
  176.                                 not use alphanumeric area numbers,
  177.                                 otherwise messages will get posted to
  178.                                 the wrong areas.
  179.  
  180.                             /AreaName
  181.                                 Use the shorter area name instead of the
  182.                                 longer area description for conference
  183.                                 name in the QWK CONTROL.DAT. Most BBSes
  184.                                 do not put anything meaningful in this
  185.                                 field.
  186.  
  187.                   These .CFG options may be appended to the command
  188.                   normal BlueQWK command line if they do not exceed the
  189.                   DOS command line limit of 128 characters.  For
  190.                   example:
  191.  
  192.                   BLUEQWK BBS_ID cvt_method qwk_dir rep_dir /switches
  193.  
  194.           ═════════════════════════════════════════════════════════════
  195.           STANDALONE OPERATION:
  196.  
  197.             1. Create a temporary work directory and decompress your
  198.                Blue Wave mail packet into it.
  199.  
  200.             2. Copy BLUEQWK.EXE to a directory on your DOS path.  Make
  201.                sure it resides a directory different from the work
  202.                directory created in step 1.
  203.  
  204.             3. Execute BlueQWK with the following options:
  205.  
  206.                  BLUEQWK * BW-QWK .\ .\
  207.  
  208.             4. If the above step is sucessful, re-compress the content
  209.                of work the directory packet into a QWK packet.
  210.  
  211.             5. If you cannot perform perform the above 4 steps, then
  212.                you really need help in PC operation basics.  I can
  213.                provide personal one-on-one in-home training starting
  214.                from $25.00 per hour plus expenses.
  215.  
  216.           ═════════════════════════════════════════════════════════════
  217.           That's  all there's  to it.   You can now  read BlueWave mail
  218.           packets with your favorite QWK reader.
  219.  
  220.           I like to think this document short, complete and helpful.
  221.           If you have problems with the program, please do not hesitate
  222.           to contact me.
  223.  
  224.           ═════════════════════════════════════════════════════════════
  225.           MAILER READER INTERFACE FOR BLUEQWK: For QWK reader authors:
  226.  
  227.           These simple additions to any mail reader would be helpful
  228.           for third party programs to interface with the mail reader.
  229.  
  230.           To interface with BlueQWK, the mail reader should provide the
  231.           ability to run 3 .BAT files and pass 3 parameters to BlueQWK.
  232.  
  233.           The .BAT files:
  234.  
  235.              1. POSTQWK.BAT - Run after the reader decompress the .QWK
  236.                               packet.
  237.  
  238.              2. POSTREP.BAT - Run after the reader decompress the .REP
  239.                               packet.
  240.  
  241.              3. PREREP.BAT  - Run before the reader compress the .MSG
  242.                               into a .REP file.
  243.  
  244.           These .BAT files can be any name, as long as they are known
  245.           to the users of the mail reader (ie: documented).
  246.  
  247.           The Parameters:
  248.  
  249.              1. QWK work path - Path to the directory where the QWK
  250.                                 packet was decompressed to.
  251.  
  252.              2. REP work path - The directory where the <BBS_ID>.MSG is
  253.                                 stored.
  254.  
  255.              3. The <BBS_ID>  - The name of the QWK file.  This is not
  256.                                 necessary, but can reduce error if
  257.                                 BlueQWK doesn't have to guess.
  258.  
  259.           Optional:
  260.  
  261.           Make the reader recognize the Bluewave naming format.  The
  262.           current naming convention for Bluewave format folows:
  263.  
  264.            <BBS_ID>.DA#  - DA is the first 2 letter of the day followed
  265.                            by a number 0 to 9.  Thus the first mail
  266.                            packet downloaded on Monday would have .MO0
  267.                            as the file extension.
  268.  
  269.            <BBS_ID>.###  - This newer naming convention gives the file
  270.                            extension any number between 000 to 999.
  271.  
  272.            <BBS_ID>.NEW  - The Bluewave reply packet should have .NEW
  273.                            as the file extension.
  274.  
  275.           ═════════════════════════════════════════════════════════════
  276.           KNOWN LIMITATIONS:
  277.  
  278.            ■ When converting from Bluewave to QWK, all conferences will
  279.              be sequentially numbered starting from 0.  This is a QWK
  280.              structure limitation: Bluewave uses alpha-numeric value
  281.              for conference names, QWK _must_ have numeric value for
  282.              conference names.  Try converting the word 'BLUEWAVE' to a
  283.              meaningful number.
  284.  
  285.              On BBS systems that use numeric value for conference
  286.              names, the conference number converted by BlueQWK will not
  287.              be the same as the one on the BBS.  However, this does not
  288.              affect your ability to read/write messages to the proper
  289.              conferences.  Bluewave uses conference names, not numbers.
  290.  
  291.            ■ For anyone using BlueQWK with CAM-MAIL BLUE: Why?!  What's
  292.              wrong with the QWK door??!!
  293.  
  294.            ■ Maximum 16000 conferences, but it depends on the amount
  295.              conventional memory available.  BlueQWK makes no attempt
  296.              to use any memory outside the 640K range.
  297.  
  298.           ═════════════════════════════════════════════════════════════
  299.           REVISION HISTORY:
  300.  
  301.           25-Oct-1996 - v1.70 -----------------------------------------
  302.  
  303.            ■ Extra spaces from message header and end of messages are
  304.              now stripped to make messages look cleaner.
  305.  
  306.            ■ Fixed the display of BlueQWK version number.
  307.  
  308.            ■ Added /AREANUM function to use BBS area numbers instead of
  309.              creating sequential ones.  Make sure the BBS does not use
  310.              alphanumeric area numbers, otherwise messages will get
  311.              posted to the wrong areas.  This was the method of area
  312.              number handling used in BlueQWK prior to version 1.50.
  313.              This method is known NOT to work with the most Maximus BBS
  314.              version of Bluewave door.
  315.  
  316.            ■ Added /AREANAME function to use the shorter area name
  317.              instead of the longer area description for conference name
  318.              in the QWK CONTROL.DAT.  Most BBSes do not put anything
  319.              meaningful in this field.
  320.  
  321.           08-Jan-1996 - v1.60 -----------------------------------------
  322.  
  323.            ■ Additional command line parameters replace the need for
  324.              BLUEQWK.CFG.  DOS only supports command lines up to 128
  325.              characters, use BLUEQWK.CFG if paths and command line
  326.              options exceed this limit.
  327.  
  328.            ■ BlueQWK will now accept parameter #3 as the QWK work
  329.              directory, #4 as REP work directory, everything after are
  330.              optional switches.  For example:
  331.  
  332.                BLUEQWK bbs_id cvt qwk_dir rep_dir
  333.  
  334.            ■ For registered users with internet email address, please
  335.              request your 386/486 optimized version of BlueQWK.  This
  336.              386 version will not work without a valid registration key.
  337.  
  338.           11-Dec-1994 - v1.55 -----------------------------------------
  339.  
  340.            ■ The previous update caused BlueQWK to load the .INF file to
  341.              the wrong memory address under certain conditions.  This
  342.              can cause the computer to lock-up.
  343.  
  344.            ■ Run time errors are now logged to ERRORLOG.GS.
  345.  
  346.           09-Dec-1994 - v1.54 -----------------------------------------
  347.  
  348.            ■ Increased memory requirement to process large .INF files.
  349.  
  350.            ■ Instead of exiting quietly, error messages are now
  351.              displayed.
  352.  
  353.            ■ Added /NoERR to suppress display of error messages.
  354.  
  355.           15-Sep-1994 - v1.53 -----------------------------------------
  356.  
  357.            ■ Added the ability to convert the .INF to a CONTROL.DAT
  358.              with-out the need for the rest of the mail packet.  Needed
  359.              for SPEED Read.
  360.  
  361.            ■ Brought back the asterisk '*'.  If the mail packet is not
  362.              known, use the the asterisk in place of the BBS_ID and
  363.              BlueQWK will automatically locate the BBS_ID.
  364.  
  365.            ■ Added configurations for SPEED READ and RoboMail.
  366.  
  367.           12-Aug-1994 - v1.52 -----------------------------------------
  368.  
  369.            ■ Updated to comply with the official Bluewave specification.
  370.  
  371.            ■ Included sample configuration files for other mail readers.
  372.  
  373.            ■ Added options /Quiet, /NoNDX, /1stBM
  374.  
  375.           28-Feb-1994 - v1.51 -----------------------------------------
  376.  
  377.            ■ Updated contact information.
  378.  
  379.           10-Nov-1993 - v1.50 -----------------------------------------
  380.  
  381.            ■ Updated for compatibility with other versions of the
  382.              Bluewave door. Previous versions of BlueQWK only worked
  383.              with Remote Access and QuickBBS versions of the Bluewave
  384.              door.
  385.  
  386.            ■ Beginning with this version, BlueQWK is now Shareware.
  387.              Please register if you it regularly.
  388.  
  389.           19-Jul-1993 - v1.31 -----------------------------------------
  390.  
  391.            ■ Minor cosmetic to the R2B module.  If you can read fast
  392.              enough, you'll see the messages being converted.
  393.  
  394.           25-Jun-1993 - v1.30 -----------------------------------------
  395.  
  396.            ■ I've moved recently.  Please note the new address.
  397.  
  398.            ■ More compatible with the BlueWave door.
  399.  
  400.            ■ Added the 3rd conversion module BW-REP.
  401.  
  402.            ■ Combined all 3 conversion modules into a single .EXE.
  403.  
  404.            ■ Command line options changed.
  405.  
  406.           25-Feb-1993 - v1.20 -----------------------------------------
  407.  
  408.            ■ Speeded up some more
  409.  
  410.            ■ Added some junk into the .UPI file to cure some BlueWave
  411.              door rejecting good replies as duplicates.
  412.  
  413.            ? I still don't have a clue what some of the junk in the .UPI
  414.              file is.  So don't expect this to be 100% compatible with
  415.              all BlueWave doors.  Anyone been able to get the BlueWave
  416.              structure from the author?
  417.  
  418.           10-Feb-1993 - v1.10 -----------------------------------------
  419.  
  420.            ■ Speeded up by at least 2 times
  421.  
  422.            ■ R2B converts from .REP to BlueWave
  423.  
  424.           15-Nov-1992 - v1.00 -----------------------------------------
  425.  
  426.            ■ Initial Release
  427.  
  428.           ═════════════════════════════════════════════════════════════
  429.           REGISTRATION:
  430.  
  431.           If you have questions,  bugs, comments or suggestions, please
  432.           email me.  Registered users of my other Shareware packages may
  433.           contact me using the voice number in the registration document.
  434.  
  435.           Since BlueQWK  is user supported software, I don't expect you
  436.           to register if you don't like it or if it doesn't meet your
  437.           needs.  Just stop  using it after a reasonable  trial period.
  438.           BlueQWK is not crippled in any way, but some minor annoyance
  439.           features may be active in unregistered mode.
  440.  
  441.           BlueQWK  is an  on-going  project, it  will  be enhanced  and
  442.           updated as long as I can financially afford to do so.  If you
  443.           like the program  and use it  regularly, please register  it.
  444.           The registration cost is a one-time  fee of $5.00.  With the
  445.           registration  you'll  receive  unlimited  voice  support  and
  446.           upgrades.   Your registration encourages further development,
  447.           enhancements and my continued support of the product.  Please
  448.           send your registration in the form of a Money Order, Personal
  449.           cheque, or Cashier's cheque to the above address.
  450.  
  451.           ═════════════════════════════════════════════════════════════
  452.           STANDARD DISCLAIMER:
  453.  
  454.           This program is provided on an "AS IS" basis.  No warranty of
  455.           any kind is expressed  or implied.  I take  no responsibility
  456.           for  any damage caused directly or indirectly from the use or
  457.           the  inability to  use this  program.   Only features  in the
  458.           current .EXE, including bugs, critters and anything else that
  459.           might be pressent, are available to the users.  Users are not
  460.           to expect future upgrades or additional features. The program
  461.           will not  change to suit the needs of the users if such needs
  462.           change  in  the  future.   By  using  this  program the  user
  463.           automatically accepts these terms and conditions.
  464.  
  465.           ═════════════════════════════════════════════════════════════
  466.           COPYRIGHTS:
  467.  
  468.           Products mentioned  in this documentation are  Copyrighted or
  469.           Trademarks of their respective holders:
  470.  
  471.           1stReader, Deluxe:       Mark "Sparky" Herring of Sparkware.
  472.                                    The original creator of the popular
  473.                                    QWK mail standard.
  474.  
  475.           BlueWave:                George   Hatchew  of   Cutting  Edge
  476.                                    Computing.  The original creator of
  477.                                    the BlueWave format.
  478.  
  479.           OLX:                     Mustang Software Inc.
  480.  
  481.           SPEED READ:              Jim Smith.
  482.  
  483.           RoboMail:                Parson Consulting.
  484.  
  485.           ═════════════════════════════════════════════════════════════
  486.  
  487.